Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Relax type of ServiceCheck enum items #6064

Merged
merged 1 commit into from
Mar 16, 2020
Merged

Relax type of ServiceCheck enum items #6064

merged 1 commit into from
Mar 16, 2020

Conversation

florimondmanca
Copy link
Contributor

What does this PR do?

Relax the type of individual service check enum items, eg ServiceCheck.OK, etc.

Motivation

Prevent needless type checking nits such as:

status = self.OK
if <condition>:
    status = self.CRITICAL
error: Incompatible types in assignment (expression has type "Literal[1]", variable has type "Literal[0]")

Eg currently this part of the SNMP check flags red needlessly:

integrations-core/snmp/datadog_checks/snmp/snmp.py

Lines 371 to 376 in f81d305

# Report service checks
status = self.OK
if error:
status = self.CRITICAL
if results:
status = self.WARNING

Additional Notes

Review checklist (to be filled by reviewers)

  • Feature or bugfix MUST have appropriate tests (unit, integration, e2e)
  • PR title must be written as a CHANGELOG entry (see why)
  • Files changes must correspond to the primary purpose of the PR as described in the title (small unrelated changes should have their own PR)
  • PR must have changelog/ and integration/ labels attached

@florimondmanca florimondmanca requested review from a team as code owners March 16, 2020 12:15
@codecov
Copy link

codecov bot commented Mar 16, 2020 •
edited
Loading

Codecov Report

Merging #6064 into master will increase coverage by 0.03%.
The diff coverage is n/a.

Impacted Files Coverage Δ
datadog_checks_base/datadog_checks/base/types.py 100.00% <ø> (ø)
crio/datadog_checks/crio/__init__.py
crio/tests/test_crio.py
crio/datadog_checks/crio/__about__.py
crio/datadog_checks/crio/crio.py
...downloader/datadog_checks/downloader/parameters.py 88.88% <0.00%> (ø)
mysql/tests/test_mysql.py 88.88% <0.00%> (ø)
scylla/datadog_checks/scylla/metrics.py 100.00% <0.00%> (ø)
wmi_check/tests/conftest.py 84.09% <0.00%> (ø)
riakcs/tests/test_integration.py 100.00% <0.00%> (ø)
... and 141 more

@florimondmanca
Copy link
Contributor Author

florimondmanca commented Mar 16, 2020 •
edited
Loading

Tests are failing due to unrelated reasons:

  • ClickHouse: new undocumented metrics
  • HTTP: TLS certificate of https://sha256.badssl.com/ is approaching expiration (expires in 8 days), so one of the SCs is WARNING instead of OK.
  • TLS: TLS certificate of several endpoints we call are approaching expiration (expire in 8 days), so the expiration SC is WARNING instead of OK.

So, merging, and will see if there are ways to remove flakiness on these aspects…

(Edit: clicked the "Close" button by mistake!)

@florimondmanca florimondmanca merged commit 248347b into master Mar 16, 2020
@florimondmanca florimondmanca deleted the florimondmanca/relax-servicecheckstatus-type branch March 16, 2020 14:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hithwen hithwen hithwen approved these changes

@AlexandreYang AlexandreYang AlexandreYang approved these changes

Assignees
No one assigned
Labels
integration/datadog_checks_base
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@florimondmanca @hithwen @AlexandreYang